GlassFish - World's first Java EE 7 Application Server


This page lists out all the CLI remote commands thats available in 3.1.2,  and maps that to the functionality provided in Admin Console.

Applications Support:

CLI     Supported in 3.1.1 GUI   Add support in 3.1.2 ? Doc Subtask Comments    
list-applications                    list-components
show-component-status     list-sub-components 		yes      
deploy            deploydir
undeploy       redeploy 		yes      
list-application-refs   create-application-ref
delete-application-ref
yes      
disable enable
yes      
list-lifecycle-modules delete-lifecycle-module
create-lifecycle-module
yes      
get-client-stubs
No DONE.  P3. GLASSFISH-17554

 GLASSFISH-17790 was available in v2.
list-web-context-param    list-web-env-entry    
set-web-context-param   set-web-env-entry
unset-web-context-param unset-web-env-entry 		No P4. GLASSFISH-17622 GLASSFISH-17807 no user request.  never supported in GUI.  
considerable effort to support this in 3.1.2.  
Will consider this for future release.

Nodes

CLI     Supported in 3.1.1 GUI   Add support in 3.1.2 ? Doc Subtask
Comments    
create-node-config create-node-ssh 
create-node-config create-node-ssh 		Yes      
list-nodes list-nodes-config list-nodes-ssh Yes      
delete-node-config delete-node-ssh update-node-config update-node-ssh   Yes      
install-node install-node-ssh No DONE. P2, GLASSFISH-17552 GLASSFISH-17792
uninstall-node uninstall-node-ssh No DONE. P2. GLASSFISH-17552 GLASSFISH-17792 Need backend to convert this to Remote command. GLASSFISH-17553
ping-node-ssh No DONE. P2. GLASSFISH-17555 DONE GLASSFISH-17791  
ping-node-dcom N/A DONE. P2. GLASSFISH-17555 DONE GLASSFISH-17791  
list-nodes-dcom create-node-dcom delete-node-dcom update-node-dcom N/A DONE. P2, GLASSFISH-17556 DONE GLASSFISH-17808  
install-node-dcom   uninstall-node-dcom N/A DONE. P2. GLASSFISH-17555 GLASSFISH-17791 Need backend to convert this to Remote command.
setup-ssh
No
DONE. GLASSFISH-17736 GLASSFISH-17809 Need backend to convert this to Remote command. GLASSFISH-17524
validate-dcom N/A DONE. P3. GLASSFISH-17624 GLASSFISH-17810
  

Clusters and Instances

CLI     Supported in 3.1.1 GUI   Add support in 3.1.2 ? Doc Subtask
Comments    
list-clusters create-cluster delete-cluster Yes      
start-cluster stop-cluster
Yes      
restart-instance
Yes      
list-instances create-instance delete-instance
Yes      
start-instance stop-instance
Yes      
get-health
No DONE. P2. GLASSFISH-17570  GLASSFISH-17811 depends on GLASSFISH-17571  (FIXED)
export-sync-bundle
No Nice-to-have   This can easily be done using CLI,  and since "import-sync-bundle' is
a local command,  user will need to rely on CLI to restore the configuration.  
Not critical to provide this support in GUI.


Load Balancer Configurations:  New features added in 3.1.2

CLI     Supported in 3.1.1 GUI   Add support in 3.1.2 ? Comments    
list-http-lb-configs list-http-lbs No Yes, DONE  
create-http-health-checker    create-http-lb
create-http-lb-config               create-http-lb-ref
No Yes, DONE  
delete-http-health-checker    delete-http-lb
delete-http-lb-config               delete-http-lb-ref
No Yes, DONE  
disable-http-lb-application enable-http-lb-application
No Yes, DONE  
disable-http-lb-server enable-http-lb-server
No Yes, DONE  
configure-lb-weight
No Yes, DONE  
export-http-lb-config
No Yes, DONE  
apply-http-lb-changes
No Yes, DONE  

Secure Administration, Password and Password Aliasing

CLI     Supported in 3.1.1 GUI   Add support in 3.1.2 ? Comments    
enable-secure-admin,  
disable-secure-admin 		No Yes New Feature added for 3.1.2
list-secure-admin-internal-users
enable-secure-admin-internal-users
disable-secure-admin-internal-users
No Nice-to-have these cmds are added for a specific customer.  
probably not widely used by others.
list-secure-admin-principals
list-secure-admin-principals
list-secure-admin-principals
No Nice-to-have these cmds are added for a specific customer.  
probably not widely used by others.
list-password-aliases
delete-password-alias
create-password-alias
update-password-alias 		Yes    
change-admin-password Yes    

Transactions

CLI     Supported in 3.1.1 GUI   Add support in 3.1.2 ? Doc Subtask
Comments    
recover-transactions Yes      
freeze-transaction-service
unfreeze-transaction-service
rollback-transaction 		No P4 GLASSFISH-17710 GLASSFISH-17818 We didn't get any request to support this.

Misc

CLI     Supported in 3.1.1 GUI   Add support in 3.1.2 ? Doc Subtask
Comments    
version Yes      
uptime No DONE. P3 GLASSFISH-17585 GLASSFISH-17812
 depends on GLASSFISH-17776
Useful info to display to user.
generate-domain-schema No Nice-to-have   never supported in previous release. no request
configure-ldap-for-admin No Nice-to-have   never supported in previous release.
collect-log-files No DONE. P3 GLASSFISH-17627 GLASSFISH-17813
 may help diagnostic
list-jndi-entries No P2 GLASSFISH-5842   v2 has JDNI browser. has 11 votes for this RFE.
list-timers No DONE. P3 GLASSFISH-17629 GLASSFISH-17814
 depends on GLASSFISH-17785
Never supported in previous release, but will be nice to see the list of timers before calling migrate-timers.

migrate-timers Yes      
list-modules No P4 GLASSFISH-17630 GLASSFISH-17815
no request from user.
list-containers No P4 GLASSFISH-17631 GLASSFISH-17816
no request from user.

Configurations

CLI     Supported in 3.1.1 GUI   Add support in 3.1.2 ? Comments    
generate-jvm-report Yes    
list-configs
copy-config
delete-config 		Yes    
list-jvm-options
create-jvm-options
delete-jvm-options 		Yes    
create-profiler
delete-profiler 		Yes    
list-audit-modules
create-audit-module
delete-audit-module 		Yes    
list-auth-realms
create-auth-realm
delete-auth-realm 		Yes    
list-file-users
create-file-user
delete-file-user
update-file-user 		Yes    
list-http-listeners
create-http-listener
delete-http-listener 		Yes    
create-jacc-provider
delete-jacc-provider
list-jacc-providers 		Yes    
create-message-security-provider
delete-message-security-provider
list-message-security-providers 		Yes    
list-network-listeners
create-network-listener
delete-network-listener 		Yes    
list-protocols
create-protocol
delete-protocol 		Yes    
create-http
delete-http 		Yes    
create-ssl
delete-ssl 		Yes    
list-system-properties
create-system-properties
delete-system-property 		Yes    
list-threadpools
create-threadpool
delete-threadpool 		Yes    
list-transports
create-transport
delete-transport 		Yes    
list-virtual-servers
create-virtual-server
delete-virtual-server 		Yes    
list-iiop-listeners
create-iiop-listener
delete-iiop-listener 		Yes    
list-file-groups Yes    
list-persistence-types Yes    
list-supported-cipher-suites Yes    
disable-monitoring
enable-monitoring 		Yes    

Low level grizzly configuration support

These commands were not support in the admin console because it is assumed GlassFish administrator is very unlikely to do this low level grizzly configuration.

CLI     Supported in 3.1.1 GUI   Add support in 3.1.2 ? Comments    
list-protocol-filters
create-protocol-filter
delete-protocol-filter 		No    
list-protocol-finders
create-protocol-finder
delete-protocol-finder 		No    
create-http-redirect
delete-http-redirect 		No    

Loggings

CLI     Supported in 3.1.1 GUI   Add support in 3.1.2 ? Comments    
rotate-log Yes    
set-log-attributes Yes    
set-log-levels Yes    
delete-log-levels Yes    
list-log-attributes Yes    
list-log-levels Yes    

JMS

CLI     Supported in 3.1.1 GUI   Add support in 3.1.2 ? Doc Subtask
Comments    
list-jms-resources
create-jms-resource
delete-jms-resource
list-jms-resources, create-jms-resource, delete-jms-resource 		Yes      
list-jms-hosts,  create-jms-host,  delete-jms-host Yes      
list-jmsdest, create-jmsdest, delete-jmsdest Yes      
flush-jmsdest Yes      
jms-ping Yes      
configure-jms-cluster No DONE. P2
GLASSFISH-17582 
 GLASSFISH-17793 Not supported in v2 either.   Haven't heard any customer request.
change-master-broker No DONE. P3
GLASSFISH-17779 		GLASSFISH-17794 Can easily add this in the JMS config page.  That page somehow missed the 'master broker' attribute.

Resources

CLI     Supported in 3.1.1 GUI   Add support in 3.1.2 ? Doc Subtask
Comments
list-connector-connection-pools list-connector-resources
list-connector-security-maps list-connector-work-security-maps

create-connector-connection-pool create-connector-resource
create-connector-security-map create-connector-work-security-map

delete-connector-connection-pool delete-connector-resource
delete-connector-security-map delete-connector-work-security-map

update-connector-security-map update-connector-work-security-map

ping-connection-pool
flush-connection-pool
Yes      
list-jdbc-connection-pools list-jdbc-resources
create-jdbc-connection-pool create-jdbc-resource
delete-jdbc-connection-pool delete-jdbc-resource 		Yes      
list-admin-objects
create-admin-object
delete-admin-object 		Yes      
list-resource-adapter-configs
create-resource-adapter-config
delete-resource-adapter-config 		Yes      
list-javamail-resources
create-javamail-resource
delete-javamail-resource 		Yes      
list-custom-resources
create-custom-resource
delete-custom-resource 		Yes      
list-jndi-resources
create-jndi-resource
delete-jndi-resource 		Yes      
list-resource-refs
create-resource-ref
delete-resource-ref 		Yes      
add-resources No DONE. P3 GLASSFISH-17625 GLASSFISH-17817 not supported in previous release, didn't have request to support this.



Comments:
Comment ID Location Comment
PMD-001 General If any approved issue affects the documentation, including inline help and online help, a documentation subtask of the issue is required to notify the documentation team of the required changes.
PMD-002 Nodes Support for create-node-ssh is incomplete. The Administration Console does not support the --install and --archive options of this subcommand.
PMD-003 Nodes Support for delete-node-ssh is incomplete. The Administration Console does not support the --uninstall option of this subcommand.
PMD-004 Nodes P2 seems high for install-node,install-node-ssh, install-node-dcom, uninstall-node, uninstall-node-ssh, and uninstall-node-dcom. The names of these subcommands are completely misleading, as the subcommands do not act upon nodes in the domain configuration in the DAS. They only copy GlassFish Server software files from one host to specified hosts, or remove GlassFish Server software files from specified hosts. These subcommands do not query or modify the domain configuration on the DAS. Perhaps this functionality could be provided by supporting all the options of create-node-ssh, delete-node-ssh, create-node-dcom, and delete-node-dcom.
PMD-005 Nodes setup-ssh is missing from this table. Like install-node-ssh, setup-ssh is supported in local mode only, only copies files from one host to specified hosts, and does not query or modify the domain configuration on the DAS. Users can run this subcommand before using the Administration Console. For these reasons, parity with this subcommand should have low priority, probably P4, if any.
PMD-006 Misc One could argue that generate-domain-schema is not supported. This subcommand is not documented and, to my knowledge has not been tested.
Posted by pauldavies at Nov 08, 2011 11:27

Paul, Thanks for the comments and feedback.

PMD-001: We will ensure that doc bugs will be filed for anything that will affect docs.

PMD-002, PMD-003 and PMD-004: it is about install and delete node. I didn't specify exactly how install and delete node will be supported, ie, the UI part of that.
install-node, install-node-ssh and install-node-dcom will be added as an option when creating the node. There will NOT be separate screen just for that command. This will also take care of PMD-002 and PMD-003 that you mentioned about missing the "--install" and "--archive" option.

delete-node will provide the option of doing the un-installation as well.
The change in current UI to support all this is actually pretty simple. This is based on discussion with Joe.

PMD-005 setup-ssh will also be an option in the Create Node screen. A checkbox will be provided that if selected, will run setup-ssh first BEFORE creating the SSH node.
Posted by 3070 at Nov 08, 2011 16:40

PMD-001: Thanks. To ensure that the doc subtasks are completed for 3.1.2, please file all the required JIRA issues by Friday November 18, 2011. The documentation team cannot commit to fixing for 3.1.2 any issues that are filed after that date.

PMD-002, PMD-003 and PMD-004: The converse of install is uninstall, not delete. I assume that the Administration Console UI will use the correct terminology. As I said before, the names of the [un]install-* subcommands are confusing.

PMD-005: I have added setup-ssh to the table in the Nodes section of this page.
Posted by pauldavies at Nov 15, 2011 09:43